sdk/samples/all in on code/Visual Studio 2010/CSWebDownloader/IDownloader.cs

   1 /****************************** Module Header ******************************\
   2  * Module Name:  IDownloader.cs
   3  * Project:      CSWebDownloader
   4  * Copyright (c) Microsoft Corporation.
   5  *
   6  * This interface defines the basic properties and methods of a WebDownloader.
   7  *
   8  * This source is subject to the Microsoft Public License.
   9  * See http://www.microsoft.com/opensource/licenses.mspx#Ms-PL.
  10  * All other rights reserved.
  11  *
  12  * THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
  13  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
  14  * WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
  15 \***************************************************************************/
  16
  17 using System;
  18 using System.Net;
  19 namespace CSWebDownloader
  20 {
  21     public interface IDownloader
  22     {
  23         #region Basic settings of a WebDownloader.
  24
  25         Uri Url { get; }
  26         string DownloadPath { get; set; }
  27         long TotalSize { get; set; }
  28
  29         ICredentials Credentials { get; set; }
  30         IWebProxy Proxy { get; set; }
  31
  32         #endregion
  33
  34
  35         #region Support the "Pause", "Resume" and Multi-Threads feature.
  36
  37         bool IsRangeSupported { get; set; }
  38         long StartPoint { get; set; }
  39         long EndPoint { get; set; }
  40
  41         #endregion
  42
  43         #region The downloaded data and status.
  44
  45         long DownloadedSize { get; }
  46         int CachedSize { get; }
  47
  48         bool HasChecked { get; set; }
  49         DownloadStatus Status { get; }
  50         TimeSpan TotalUsedTime { get; }
  51
  52         #endregion
  53
  54         #region Advanced settings of a WebDownloader
  55
  56         int BufferSize { get; set; }
  57         int BufferCountPerNotification { get; set; }
  58         int MaxCacheSize { get; set; }
  59
  60         #endregion
  61
  62
  63         event EventHandler<DownloadCompletedEventArgs> DownloadCompleted;
  64         event EventHandler<DownloadProgressChangedEventArgs> DownloadProgressChanged;
  65         event EventHandler StatusChanged;
  66
  67         void CheckUrl(out string fileName);
  68
  69         void BeginDownload();
  70         void Download();
  71
  72         void Pause();
  73
  74         void Resume();
  75         void BeginResume();
  76
  77         void Cancel();
  78     }
  79 }